// Written in the D Programming Language
/*
 * Copyright (c) 2008 OpenGLUtils
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'OpenGLUtils' nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
module openglutils.GLDisplayList;

import openglutils.GL;
import openglutils.GLObject;

/**
 * GLDisplayList provides functions for handling a single display list.
 */
public class GLDisplayList : GLObject
{
	private void _newList(GLuint T)(void delegate() gd)
	{
		glNewList(getId(), T);
		gd();
		glEndList();
	}
	
	/**
	 * Compile a new display list with the provided delegate. Do not put calls to glNewList and glEndList in 
	 * the delegate as they are called by this function. The glNewList is called with mode GL_COMPILE.
	 * 
	 * Params:
	 * 	gd = the delegate which should call the needed OpenGL functions to create the display list
	 */
	public alias _newList!(GL_COMPILE) compileList;
	
	/**
	 * Compiles and executes a new display list with the provided delegate. Do not put calls to glNewList and glEndList 
	 * in the delegate as they are called by this function. The glNewList is called with mode GL_COMPILE_AND_EXECUTE.
	 * 
	 * Params:
	 * 	gd = the delegate which should call the needed OpenGL functions to create the display list
	 */
	public alias _newList!(GL_COMPILE_AND_EXECUTE) compileAndExecuteList;
	
	/**
	 * Calls the display list.
	 */
	public void call()
	{
		glCallList(getId());
	}
	
	/**
	 * Checks if the given id is a display list.
	 * 
	 * Params:
	 *     id = the id to be checked 
	 * Returns: True if the id is a display list, false otherwise.
	 */
	public static bool isList(GLuint id) 
	{
		return glIsList(id) == GL_TRUE;
	}
	
	protected void destroy()
	{
		glDeleteLists(getId(), 1);
	}

    protected GLuint generateID()
    {
    	return glGenLists(1);
    }
}



